1.基本约定
1.当接口处理正常时,HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。
2.当接口处理异常时,HTTP STATUS CODE 返回给500,并且给出具体的错误信息。
{
"uri" : "/intf/albums-by-type.jsp",
"error-desc":"Need you follow uid.",
"user-notice":"给用户的提示放在这里"
}
3.接口默认的字符编码是UTF-8,接口需要实现对req-enc和resp-enc参数的支持。在JSP的最顶部,实现类似下面的代码:
String queryString = request.getQueryString();
String requestEncoding = getParam(queryString,"req_enc");
String responseEncoding = getParam(queryString,"resp_enc");
if(isNotBlank(requestEncoding)){
request.setCharacterEncoding(requestEncoding);
}
if(isNotBlank(responseEncoding)){
response.setCharacterEncoding(responseEncoding);
}
4.所有有写操作的数据接口,必须用POST方式提交,在接口里需要判断提交方式,拒绝GET的调用请求。
5.接口中的JSON字符串,key都用双引号("")包裹,value是字符串类型时,也用双引号("")包裹;是数字类型时,不用引号。
2.接口列表
2.1 新消息
url:http://mrobot.pcauto.com.cn/v3/bbs/getNewMsgCount (已上线)
作用:获取汽车论坛系统消息和站内信(短消息)的数量
使用范围:汽车网论坛app
备注:屏蔽车主认证失败的信息
HTTP请求方式:get
是否需要登录:是
common_session_id:用户登陆后获得的认证id
返回参数:
{
"systemNoticeCount": 0, //系统消息数
"messageCount": 0, // 短消息数
"fansCount": 0 //新粉丝数
}
2.2 我的帖子
url: http://mrobot.pcauto.com.cn/v3/bbs/myTopics/13128876?pageNo=1&pageSize=20&maxLength=20 (已上线)
与汽车客户端4.0共用接口,详细参考接口2.3: http://trac.pc.com.cn/iphone/wiki/pcauto_pconline_4.0.0/intf#a2.3我的帖子
作用:获取某用户发布的所有帖子
使用范围:汽车网论坛app、汽车网app
是否需要登录:是
请求参数:
common_session_id:用户登陆后获得的认证id
用户ID ,如上面url中的数值 13128876
pageNo 页数
pageSize 每页条数
maxLength:帖子内容显示最大长度
2.3 我回复的
url:http://mrobot.pcauto.com.cn/v3/bbs/myReplys/13128876?pageNo=1&pageSize=20&maxLength=20 (已上线)
作用:获取某用户发表的所有回复
使用范围:汽车网论坛app
请求方式:get
是否需要登录:是
请求参数:
common_session_id:用户登陆后获得的认证id
用户ID,如上面url中的数值 13128876
pageNo:页数
pageSize:每页条数
maxLength:帖子内容显示最大长度
例子:
{
"pageNo":1, //页码
"pageSize":20, //每页条数
"topicList":[ /
{/每条的数据
"updateAt":123, //格式是时间戳,创建或最终修改时间
"floor":812,//评论所属的楼层
"name":"爱车", //用户名
“userId”:12314212, //用户id
"title":"三两下root好并精简你的三星I9100",//标题
"replyContent":"回复内容为9", //回复内容
"topicId":13597147, // 帖子id
"replyCount":6175,//回复数
"view":195872,//阅读数
"uri":"http://itbbs.pconline.com.cn/mobile/13597147.html" //帖子url
}
],
"total":12 //一共多少条
}
2.4 最新消息
url:http://mrobot.pcauto.com.cn/v3/bbs/getNewMessage?pageSize=30&pageNo=1 (已上线)
作用:获取系统消息、站内信和别人对用户帖子的回复
使用范围:汽车网论坛app
请求方式:get
是否需要登录:是
请求参数:
pageNo:页数
common_session_id:用户登陆后获得的认证id
pageSize:每页条数
例子:
{
"pageNo":1, //页码
"pageSize":20, //每页条数
"topicList":[ /
{/每条的数据
"updateAt":123, //格式是时间戳,创建或最终修改时间
“tag”:”postReply” //包括''system”,”stationMail”,”postReply” 三种类型
"content":"三两下root好并精简你的三星I9100", //内容,三者都有 ,字数有限制
"uri":"http://itbbs.pconline.com.cn/mobile/13597147.html" //postReplay独有url
“username”:”haha” //postReplay,stationMail 中的用户名
"userphoto":"www.baidu.com/hhaha.jpg", //postReplay,stationMail 中的用户头像
“useId”: 12314212 //postReplay,stationM ail 中的用户id
“title”: “给力三星I9100” //postReplay中的帖子标题
“floorIndex”: 3 //postReplay中的回帖的楼层数
"topicId":13597147, // postReplay帖子id
}
],
"total":12 //一共多少条
}
2.5 头像修改
url:http://upc.pcauto.com.cn/upload_head.jsp
作用:修改用户头像
使用范围:汽车网论坛app
请求方式:post
是否需要登录:是
请求参数:
common_session_id:会话id
image:用户头像数据
uploadType: 上传类型,缺省为正式头像。如果是"temp"则保存在头像临时目录待处理。
返回(json):
失败:{retCode: xxx}
成功:{retCode: 0}
2.5.1 获取用户信息
url: http://mrobot.pcauto.com.cn/v3/bbs/getUserInfo (已上线)
与汽车客户端4.0共用接口,详细参考接口2.5.1: http://trac.pc.com.cn/iphone/wiki/pcauto_pconline_4.0.0/intf#a2.5.1获取用户信息
作用:同步论坛收藏的内容
使用范围:汽车网论坛app、汽车网app
是否需要登录:是
请求参数:
common_session_id:用户登陆后获得的认证id
2.5.2 发送站内信
url:http://bip.pcauto.com.cn/intf/message.jsp?act=create
作用:给其他人发送站内信
使用范围:汽车网论坛app
请求方式:post
是否需要登录:是
请求参数:
accountId 发送给某个用户
content 消息内容
captcha 验证码
/*
* 发送限制 add by handy 2012.04.01
* 1.post 2.验证码 3.黑名单
* 4.邮箱绑定,该限制仅限於2012-01-01起注册的用户 edit by handy 2012.04.10
* 5.发送频率 50次/ID/24H
* 6.白名单最多一次发送50个用户,非白名单则每次只能发一个 7.添加关键词库过滤
*/
结果返回
{code:0,message:"提示"}
2.6 同步内容下载
url: http://mrobot.pcauto.com.cn/v3/bbs/collectionDownload/13128876?pageNo=1&pageSize=20 (已上线)
与汽车客户端4.0共用接口,详细参考接口2.6: http://trac.pc.com.cn/iphone/wiki/pcauto_pconline_4.0.0/intf#a2.6同步内容下载
作用:同步论坛收藏的内容
使用范围:汽车网论坛app、汽车网app
Http请求方式:get
是否需要登录:是
请求参数:
common_session_id:用户登陆后获得的认证id
用户id,如上面链接中的参数13128876
pageNo 页数
pageSize 每页显示的最大条数
2.7 同步内容上传
url: http://mrobot.pcauto.com.cn/v3/bbs/collectionUpload (已上线)
与汽车客户端4.0共用接口,详细参考接口2.7: http://trac.pc.com.cn/iphone/wiki/pcauto_pconline_4.0.0/intf#a2.7同步内容上传
作用:同步论坛收藏的内容
使用范围:汽车网论坛app、汽车网app
请求方式:post
是否需要登录:是
请求参数:
common_session_id:用户登陆后获得的认证id
json:同步的数据提交给该参数,具体格式请看4.0中的接口说明
2.8 首页精选帖子
url:http://mrobot.pcauto.com.cn/v3/bbs/home (已上线)
作用:获取首页焦点图数据和列表的内容
使用范围:汽车网论坛app
Http请求方式:get
是否需要登录:否
请求参数:none
返回参数:
{
"focus": [
{
"title": "媳妇当车模!英朗XT用车记", //标题
"image": "http://img0.pcauto.com.cn/pcauto/app/bbs/focus/1303/LL20130327a.jpg", //焦点图片链接
"topicId": 13891367 //帖子ID
},
{
"title": "欧洲小镇拍小美女",
"image": "http://img0.pcauto.com.cn/pcauto/app/bbs/focus/1303/LL20130327.jpg",
"topicId": 13891367
}
],
"topicList": [
//每条数据
{
"createAt": 1311096173000, //发帖时间
"title": "三两下root好并精简你的三星I9100", //帖标题
"topicId": 13597147, //帖子ID
"image": "http://img0.pcauto.com.cn/pcauto/app/bbs/focus/1303/LL20130327.jpg", //图片链接
"viewCount":123, //阅读数
"replyCount":123 //回复数
},
{
"createAt": 1315237579000,
"title": "都市赛车6(Asphalt 6)更新v3.1.9 for I9100",
"topicId": 13891367,
"image": "http://img0.pcauto.com.cn/pcauto/app/bbs/focus/1303/LL20130327.jpg",
"viewCount":123, //阅读数
"replyCount":123 //回复数
}
]
}
2.9 精选页分类
url:http://mrobot.pcauto.com.cn/v3/bbs/pickTopicCategory (已上线)
作用:获取精选页的分类
使用范围:汽车网论坛app
Http请求方式:get
是否需要登录:否
请求参数:none
返回参数:
{
"category": [
//分类数组每条数据
{
"id": 1, //分类ID
"name": "自驾游" //分类名
},
{
"id": 2,
"name": "西藏之旅"
}
]
}
2.10 精选页列表
url:http://mrobot.pcauto.com.cn/v3/bbs/pickTopicList/1?pageNo=7&pageSize=20 (已上线)
作用:按分类获取精选页的列表内容
使用范围:汽车网论坛app
Http请求方式:get
是否需要登录:否
请求参数:categoryId: 分类ID
pageNo: 页数
pageSize: 每页条数
返回参数:
{
"pageNo": 1, //当前页数
"pageSize": 20, //当前返回每页条数
"total": 12, //总共有多少条
"topicList": [
{
"image": "http://img0.pcauto.com.cn/pcauto/app/bbs/focus/1303/LL20130327.jpg", //封面图片
"title": "【西藏之旅3】广州分会马自达睿翼梦幻旅途", //标题
"topicId": 13597147, //帖子ID
"updateAt":1315237579000 //录入时间
},
{
"image": "http://img0.pcauto.com.cn/pcauto/app/bbs/focus/1303/LL20130327.jpg",
"title": "【西藏之旅4】广州分会马自达睿翼梦幻旅途",
"topicId": 13597148,
"updateAt":1315237579000
}
]
}
2.11 帖子列表
url: http://mrobot.pcauto.com.cn/v3/bbs/newForums/14140?filter=pick&pageNo=1&pageSize=1 (已上线)
与汽车客户端4.0共用接口,详细参考接口2.9: http://trac.pc.com.cn/iphone/wiki/pcauto_pconline_4.0.0/intf#a2.9论坛的帖子列表重构
作用:获取某论坛下的帖子
使用范围:汽车网论坛app、汽车网app
参数:
pageNo:当前页;
pageSize:每页的帖子数;
filter:该参数的值可选如下:
replycount,按回复数排序;time,按时间筛选帖子额外添加一个参数fval=秒数;pick,精选贴;top:置顶贴。
orderby:该参数的值可选如下:
postat,发帖时间排序;replyat,回帖时间排序(默认回帖排序);
2.12 帖子终端页
url: http://mrobot.pcauto.com.cn/v2/bbs/topics/2497684?pageNo=1&pageSize=20&topicTemplate=4.0&picRule=1&viewAuthorOnly=0&app=pcautobbs (已上线)
与汽车客户端4.0共用接口,详细参考接口2.10: http://trac.pc.com.cn/iphone/wiki/pcauto_pconline_4.0.0/intf#a2.10帖子页
作用:帖子终端页
使用范围:汽车网论坛app、汽车网app
3.开发时间,负责人及进度汇报
| 批次 | 页面 | 涉及MROBOT接口 | 是否需要 HTML切图 | 需配合的接口负责人 及进度 | 接口开发 预计时间 | 接口进度(百分比) | 接口实际 完成时间 | 接口确认 |
|---|---|---|---|---|---|---|---|---|
| 第一批 | 启动 | 2.1 新消息 | - | 论坛同事(秦鸿源) | 20130506 | 100% | - | 接口确认 |
| 第一批 | 个人中心 | 2.2 我的帖子 | - | 论坛同事(秦鸿源) | 20130506 | 100% | - | 接口确认 |
| 第一批 | 个人中心 | 2.3 我回复的 | - | 论坛同事(秦鸿源) | 20130506 | 100% | - | 接口确认 |
| 第二批 | 个人中心 | 2.4 最新消息 | - | 论坛同事(秦鸿源) | 20130506 | 100% | - | 接口确认 |
| 第二批 | 个人中心 | 2.5 头像修改 2.5.1 获取用户信息 2.5.2 发送站内信 | - | 论坛同事(秦鸿源) | 20130506 | 100% | - | 接口确认 |
| 第二批 | 个人中心-收藏夹 | 2.6 同步内容下载 | - | 论坛同事(秦鸿源) | 20130506 | 100% | - | 接口确认 |
| 第二批 | 个人中心-收藏夹 | 2.7 同步内容上传 | - | 论坛同事(秦鸿源) | 20130506 | 100% | - | 接口确认 |
| 第二批 | 首页 | 2.8 首页精选帖子 | - | cms同事(甘剑威) | 20130506 | 100% | - | 接口确认 |
| 第二批 | 精选页 | 2.9 精选页分类 | - | cms同事(甘剑威) | 20130506 | 100% | - | 接口确认 |
| 第三批 | 精选页 | 2.10 精选页列表 | - | cms同事(甘剑威) | 20130506 | 100% | - | 接口确认 |
| 第三批 | 帖子列表 | 2.11 帖子列表 | - | 论坛同事(秦鸿源) | 20130506 | 100% | - | 接口确认 |
| 第四批 | 帖子终端 | 2.12帖子终端页 | - | 论坛同事(秦鸿源)和前端页面开发同事 | 20130506 | 100% | - | 接口确认 |
![(please configure the [header_logo] section in trac.ini)](http://www1.pconline.com.cn/hr/2009/global/images/logo.gif)